home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / program / rcs5ap1b.lzh / RCSFILE.5LP < prev    next >
Text File  |  1991-01-30  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. RCSFILE(5)             Programmer's Manual             RCSFILE(5)
  5.  
  6.  
  7.  
  8. NAME
  9.      rcsfile - format of RCS file
  10.  
  11. DESCRIPTION
  12.      An RCS file's contents are described by the grammar below.
  13.      The text is free format: space, backspace, tab, newline,
  14.      vertical tab, form feed, and carriage return (collectively,
  15.      _✓w_✓h_✓i_✓t_✓e _✓s_✓p_✓a_✓c_✓e) have no significance except in strings.
  16.      Strings are enclosed by @.  If a string contains a @, it
  17.      must be doubled; otherwise, strings may contain arbitrary
  18.      binary data.
  19.  
  20.      The meta syntax uses the following conventions: `|' (bar)
  21.      separates alternatives; `{' and `}' enclose optional
  22.      phrases; `{' and `}*' enclose phrases that may be repeated
  23.      zero or more times; `{' and '}+' enclose phrases that must
  24.      appear at least once and may be repeated; Terminal symbols
  25.      are in boldface; nonterminal symbols are in _✓i_✓t_✓a_✓l_✓i_✓c_✓s.
  26.  
  27.      _✓r_✓c_✓s_✓t_✓e_✓x_✓t    ::=  _✓a_✓d_✓m_✓i_✓n {_✓d_✓e_✓l_✓t_✓a}* _✓d_✓e_✓s_✓c {_✓d_✓e_✓l_✓t_✓a_✓t_✓e_✓x_✓t}*
  28.  
  29.      _✓a_✓d_✓m_✓i_✓n      ::=  head       {_✓n_✓u_✓m};
  30.                      { branch   {_✓n_✓u_✓m}; }
  31.                      access     {_✓i_✓d}*;
  32.                      symbols    {_✓i_✓d : _✓n_✓u_✓m}*;
  33.                      locks      {_✓i_✓d : _✓n_✓u_✓m}*;  {strict  ;}
  34.                      { comment  {_✓s_✓t_✓r_✓i_✓n_✓g}; }
  35.                      { expand   {_✓s_✓t_✓r_✓i_✓n_✓g}; }
  36.                      { _✓n_✓e_✓w_✓p_✓h_✓r_✓a_✓s_✓e }*
  37.  
  38.      _✓d_✓e_✓l_✓t_✓a      ::=  _✓n_✓u_✓m
  39.                      date       _✓n_✓u_✓m;
  40.                      author     _✓i_✓d;
  41.                      state      {_✓i_✓d};
  42.                      branches   {_✓n_✓u_✓m}*;
  43.                      next       {_✓n_✓u_✓m};
  44.                      { _✓n_✓e_✓w_✓p_✓h_✓r_✓a_✓s_✓e }*
  45.  
  46.      _✓d_✓e_✓s_✓c       ::=  desc       _✓s_✓t_✓r_✓i_✓n_✓g
  47.  
  48.      _✓d_✓e_✓l_✓t_✓a_✓t_✓e_✓x_✓t  ::=  _✓n_✓u_✓m
  49.                      log        _✓s_✓t_✓r_✓i_✓n_✓g
  50.                      { _✓n_✓e_✓w_✓p_✓h_✓r_✓a_✓s_✓e }*
  51.                      text       _✓s_✓t_✓r_✓i_✓n_✓g
  52.  
  53.      _✓n_✓u_✓m        ::=  {_✓d_✓i_✓g_✓i_✓t{.}}+
  54.  
  55.      _✓d_✓i_✓g_✓i_✓t      ::=  0 | 1 | ... | 9
  56.  
  57.      _✓i_✓d         ::=  _✓l_✓e_✓t_✓t_✓e_✓r{_✓i_✓d_✓c_✓h_✓a_✓r}*
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Printed 1/29/91            1990/08/22                           1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RCSFILE(5)             Programmer's Manual             RCSFILE(5)
  71.  
  72.  
  73.  
  74.      _✓l_✓e_✓t_✓t_✓e_✓r     ::=  any letter
  75.  
  76.      _✓i_✓d_✓c_✓h_✓a_✓r     ::=  any visible graphic character except _✓s_✓p_✓e_✓c_✓i_✓a_✓l
  77.  
  78.      _✓s_✓p_✓e_✓c_✓i_✓a_✓l    ::=  $ | , | . | : | ; | @
  79.  
  80.      _✓s_✓t_✓r_✓i_✓n_✓g     ::=  @{any character, with @ doubled}*@
  81.  
  82.      _✓n_✓e_✓w_✓p_✓h_✓r_✓a_✓s_✓e  ::=  _✓i_✓d _✓w_✓o_✓r_✓d* ;
  83.  
  84.      _✓w_✓o_✓r_✓d       ::=  _✓i_✓d | _✓n_✓u_✓m | _✓s_✓t_✓r_✓i_✓n_✓g | :
  85.  
  86.      Identifiers are case sensitive.  Keywords are in lower case
  87.      only.  The sets of keywords and identifiers may overlap.  In
  88.      most environments RCS uses the ISO 8859/1 encoding: letters
  89.      are octal codes 101-132, 141-172, 300-326, 330-366 and 370-
  90.      377, visible graphic characters are codes 041-176 and
  91.      240-377, and white space characters are codes 010-015 and
  92.      040.
  93.  
  94.      The _✓n_✓e_✓w_✓p_✓h_✓r_✓a_✓s_✓e productions in the grammar are reserved for
  95.      future extensions to the format of RCS files.  No _✓n_✓e_✓w_✓p_✓h_✓r_✓a_✓s_✓e
  96.      will begin with any keyword already in use.
  97.  
  98.      The _✓d_✓e_✓l_✓t_✓a nodes form a tree.  All nodes whose numbers con-
  99.      sist of a single pair (e.g., 2.3, 2.1, 1.3, etc.) are on the
  100.      trunk, and are linked through the next field in order of
  101.      decreasing numbers.  The head field in the _✓a_✓d_✓m_✓i_✓n node points
  102.      to the head of that sequence (i.e., contains the highest
  103.      pair).  The branch node in the admin node indicates the
  104.      default branch (or revision) for most RCS operations.  If
  105.      empty, the default branch is the highest branch on the
  106.      trunk.
  107.  
  108.      All _✓d_✓e_✓l_✓t_✓a nodes whose numbers consist of 2_✓n fields (_✓n)
  109.      (e.g., 3.1.1.1, 2.1.2.2, etc.) are linked as follows.  All
  110.      nodes whose first 2_✓n-1 number fields are identical are
  111.      linked through the next field in order of increasing
  112.      numbers.  For each such sequence, the _✓d_✓e_✓l_✓t_✓a node whose
  113.      number is identical to the first 2_✓n-2 number fields of the
  114.      deltas on that sequence is called the branchpoint.  The
  115.      branches field of a node contains a list of the numbers of
  116.      the first nodes of all sequences for which it is a bran-
  117.      chpoint.  This list is ordered in increasing numbers.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Printed 1/29/91            1990/08/22                           2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RCSFILE(5)             Programmer's Manual             RCSFILE(5)
  137.  
  138.  
  139.  
  140.      Example:
  141.  
  142.                                 Head
  143.                                   |
  144.                                   |
  145.                                   v                        / \
  146.                               ---------                   /   \
  147.         / \          / \      |       |      / \         /     \
  148.        /   \        /   \     |  2.1  |     /   \       /       \
  149.       /     \      /     \    |       |    /     \     /         \
  150.      /1.2.1.3\    /1.3.1.1\   |       |   /1.2.2.2\   /1.2.2.1.1.1\
  151.      ---------    ---------   ---------   ---------   -------------
  152.          ^            ^           |           ^             ^
  153.          |            |           |           |             |
  154.          |            |           v           |             |
  155.         / \           |       ---------      / \            |
  156.        /   \          |       \  1.3  /     /   \           |
  157.       /     \         ---------\     /     /     \-----------
  158.      /1.2.1.1\                  \   /     /1.2.2.1\
  159.      ---------                   \ /      ---------
  160.          ^                        |           ^
  161.          |                        |           |
  162.          |                        v           |
  163.          |                    ---------       |
  164.          |                    \  1.2  /       |
  165.          ----------------------\     /---------
  166.                                 \   /
  167.                                  \ /
  168.                                   |
  169.                                   |
  170.                                   v
  171.                               ---------
  172.                               \  1.1  /
  173.                                \     /
  174.                                 \   /
  175.                                  \ /
  176.  
  177.                        Fig. 1: A revision tree
  178.  
  179. IDENTIFICATION
  180.      Author: Walter F. Tichy, Purdue University, West Lafayette,
  181.      IN, 47907.
  182.      Revision Number: 5.0; Release Date: 1990/08/22.
  183.      Copyright c 1982, 1988, 1989 by Walter F. Tichy.
  184.      Copyright c 1990 by Paul Eggert.
  185.  
  186. SEE ALSO
  187.      ci(1), co(1), ident(1), rcs(1), rcsdiff(1), rcsmerge(1),
  188.      rlog(1),
  189.      Walter F. Tichy, RCS--A System for Version Control,
  190.      _✓S_✓o_✓f_✓t_✓w_✓a_✓r_✓e--_✓P_✓r_✓a_✓c_✓t_✓i_✓c_✓e & _✓E_✓x_✓p_✓e_✓r_✓i_✓e_✓n_✓c_✓e 15, 7 (July 1985), 637-654.
  191.  
  192.  
  193.  
  194.  
  195. Printed 1/29/91            1990/08/22                           3
  196.  
  197.  
  198.  
  199.